/**
 * Copyright (C) 2001-2020 by RapidMiner and the contributors
 *
 * Complete list of developers available at our web site:
 *
 * http://rapidminer.com
 *
 * This program is free software: you can redistribute it and/or modify it under the terms of the
 * GNU Affero General Public License as published by the Free Software Foundation, either version 3
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
 * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License along with this program.
 * If not, see http://www.gnu.org/licenses/.
 */
package com.rapidminer.gui;

import java.awt.event.ActionEvent;

import javax.swing.AbstractAction;
import javax.swing.Icon;

import com.rapidminer.tools.usagestats.ActionStatisticsCollector;


/**
 * Abstract base class for actions in Studio, implementations need to overwrite the
 * {@link #loggedActionPerformed(ActionEvent e)} method to log action executions automatically.
 *
 * @author Peter Toth
 * @since 8.0
 */
public abstract class LoggedAbstractAction extends AbstractAction {

	private static final long serialVersionUID = 1L;

	public LoggedAbstractAction() {
		super();
	}

	public LoggedAbstractAction(String name) {
		super(name);
	}

	public LoggedAbstractAction(String name, Icon icon) {
		super(name, icon);
	}

	@Override
	public void actionPerformed(ActionEvent e) {
		loggedActionPerformed(e);
		ActionStatisticsCollector.getInstance().logAction(this, e);
	}

	/**
	 * Overwrite this method to log executions automatically.
	 *
	 * @param e
	 */
	protected void loggedActionPerformed(ActionEvent e) {}

}
